JFinal Docs

# 1.3 jfinal-undertow 下部署

# 1、指定打包为类型为 jar

修改 pom.xml 文件，其中的 packaging 标签值要改成 jar

<packaging>jar</packaging>
1

强烈建议：强烈建议下载首页的 jfinal_demo_for_maven.zip，从中可以获取到本章所涉及的 pom.xml、package.xml、jfinal.sh 等配置文件与脚本文件。可以节省大量的学习成本。

# 2、添加 maven-jar-plugin 插件

<!--
	jar 包中的配置文件优先级高于 config 目录下的 "同名文件"
	因此，打包时需要排除掉 jar 包中来自 src/main/resources 目录的
	配置文件，否则部署时 config 目录中的同名配置文件不会生效
 -->
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <version>2.6</version>
    <configuration>
        <excludes>
            <exclude>*.txt</exclude>
            <exclude>*.xml</exclude>
            <exclude>*.properties</exclude>
            <exclude>exclude_file_name_here</exclude>
            <exclude>exclude_path_here/</exclude>
        </excludes>
    </configuration>
</plugin>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

maven-jar-plugin 仅为了避免将配置文件打入 jar 包，如果是打成 fatjar 包则不需要添加此插件

# 3、添加 maven-assembly-plugin 插件

修改 pom.xml ，在其中的 plugins 标签下面添加如下 maven-assembly-plugin 插件

<!-- 
    使用 mvn clean package 打包 
    更多配置可参考官司方文档：http://maven.apache.org/plugins/maven-assembly-plugin/single-mojo.html
-->
<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-assembly-plugin</artifactId>
  <version>3.1.0</version>
  <executions>
    <execution>
    <id>make-assembly</id>
    <phase>package</phase>
    <goals>
      <goal>single</goal>
    </goals>
 
    <configuration>
      <!-- 打包生成的文件名 -->
      <finalName>${project.artifactId}</finalName>
      <!-- jar 等压缩文件在被打包进入 zip、tar.gz 时是否压缩，设置为 false 可加快打包速度 -->
      <recompressZippedFiles>false</recompressZippedFiles>
      <!-- 打包生成的文件是否要追加 release.xml 中定义的 id 值 -->
      <appendAssemblyId>true</appendAssemblyId>
      <!-- 指向打包描述文件 package.xml -->
      <descriptors>
        <descriptor>package.xml</descriptor>
      </descriptors>
      <!-- 打包结果输出的基础目录 -->
      <outputDirectory>${project.build.directory}/</outputDirectory>
      </configuration>
      </execution>
    </executions>
</plugin>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

maven-assembly-plugin 是 maven 官方提供的打包插件，功能十分完善，可以配置很多参数进行定制化构建，更详细的文件参考其官方文档：http://maven.apache.org/plugins/maven-assembly-plugin/single-mojo.html

# 4、添加 package.xml 文件

在项目根目录下面添加 package.xml，该文件是在上述 maven-assembly-plugin 在 descriptor 标签中指定的打包描述文件，内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.0.0 http://maven.apache.org/xsd/assembly-2.0.0.xsd">
	
  <!-- 
    assembly 打包配置更多配置可参考官司方文档：
    http://maven.apache.org/plugins/maven-assembly-plugin/assembly.html
  -->
	
  <id>release</id>
	
  <!--
      设置打包格式，可同时设置多种格式，常用格式有：dir、zip、tar、tar.gz
      dir 格式便于在本地测试打包结果
      zip 格式便于 windows 系统下解压运行
      tar、tar.gz 格式便于 linux 系统下解压运行
  -->
  <formats>
    <format>dir</format>
    <format>zip</format>
    <!-- <format>tar.gz</format> -->
  </formats>
 
  <!-- 打 zip 设置为 true 时，会在 zip 包中生成一个根目录，打 dir 时设置为 false 少层目录 -->
  <includeBaseDirectory>true</includeBaseDirectory>
	
  <fileSets>
    <!-- src/main/resources 全部 copy 到 config 目录下 -->
    <fileSet>
      <directory>${basedir}/src/main/resources</directory>
      <outputDirectory>config</outputDirectory>
    </fileSet>
		
    <!-- src/main/webapp 全部 copy 到 webapp 目录下 -->
    <fileSet>
      <directory>${basedir}/src/main/webapp</directory>
      <outputDirectory>webapp</outputDirectory>
    </fileSet>
 
    <!-- 项目根下面的脚本文件 copy 到根目录下 -->
    <fileSet>
      <directory>${basedir}</directory>
      <outputDirectory>./</outputDirectory>
      <fileMode>755</fileMode>
      <lineEnding>unix</lineEnding>
      <includes>
        <include>*.sh</include>
      </includes>
    </fileSet>
    
    <fileSet>
      <directory>${basedir}</directory>
      <outputDirectory>./</outputDirectory>
      <fileMode>755</fileMode>
      <lineEnding>windows</lineEnding>
      <includes>
        <include>*.bat</include>
      </includes>
    </fileSet>
    
  </fileSets>	
 
  <!-- 依赖的 jar 包 copy 到 lib 目录下 -->
  <dependencySets>
    <dependencySet>
      <outputDirectory>lib</outputDirectory>			
    </dependencySet>
  </dependencySets>
	
</assembly>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

打包描述文件是 maven-assembly-plugin 的一部分，描述文件可以非常方便地控制打包的各种细节动作，更详细的文档参考：http://maven.apache.org/plugins/maven-assembly-plugin/assembly.html

# 5、在项目根目录下面添加启动脚本

注意：以下脚本文件在 jfinal 官网首页右侧下载的 jfinal demo for maven 项目中已经提供，复制其中的 jfinal.sh / jfinal.bat 到自己的项目中修改 MAIN_CLASS 变量值，即可投入使用。

Linux 下的启动脚本 jfinal.sh 内容如下：

#!/bin/bash
# --------------------------------------------------------------
#
# 使用说明：
# 1: 该脚本使用前需要首先修改 MAIN_CLASS 值，使其指向实际的启动类
#
# 2：使用命令行 ./jfinal.sh start | stop | restart 可启动/关闭/重启项目  
#
# 3: JAVA_OPTS 可通过 -D 传入 undertow.port 与 undertow.host 这类参数覆盖
#    配置文件中的相同值此外还有 undertow.resourcePath、undertow.ioThreads、
#    undertow.workerThreads 共五个参数可通过 -D 进行传入，该功能尽可能减少了
#    修改 undertow 配置文件的必要性
#
# 4: JAVA_OPTS 可传入标准的 java 命令行参数，例如 -Xms256m -Xmx1024m 这类常用参数
#
# 5: 函数 start() 给出了 4 种启动项目的命令行，根据注释中的提示自行选择合适的方式
#
# --------------------------------------------------------------
 
# 启动入口类，该脚本文件用于别的项目时要改这里
MAIN_CLASS=com.yourpackage.YourMainClass
 
if [[ "$MAIN_CLASS" == "com.yourpackage.YourMainClass" ]]; then
    echo "请先修改 MAIN_CLASS 的值为你自己项目启动Class，然后再执行此脚本。"
	exit 0
fi
 
COMMAND="$1"
 
if [[ "$COMMAND" != "start" ]] && [[ "$COMMAND" != "stop" ]] && [[ "$COMMAND" != "restart" ]]; then
	echo "Usage: $0 start | stop | restart"
	exit 0
fi
 
 
# Java 命令行参数，根据需要开启下面的配置，改成自己需要的，注意等号前后不能有空格
# JAVA_OPTS="-Xms256m -Xmx1024m -Dundertow.port=80 -Dundertow.host=0.0.0.0"
# JAVA_OPTS="-Dundertow.port=80 -Dundertow.host=0.0.0.0"
 
# 生成 class path 值
APP_BASE_PATH=$(cd `dirname $0`; pwd)
CP=${APP_BASE_PATH}/config:${APP_BASE_PATH}/lib/*
 
function start()
{
    # 运行为后台进程，并在控制台输出信息
    java -Xverify:none ${JAVA_OPTS} -cp ${CP} ${MAIN_CLASS} &
 
    # 运行为后台进程，并且不在控制台输出信息
    # nohup java -Xverify:none ${JAVA_OPTS} -cp ${CP} ${MAIN_CLASS} >/dev/null 2>&1 &
 
    # 运行为后台进程，并且将信息输出到 output.log 文件
    # nohup java -Xverify:none ${JAVA_OPTS} -cp ${CP} ${MAIN_CLASS} > output.log &
 
    # 运行为非后台进程，多用于开发阶段，快捷键 ctrl + c 可停止服务
    # java -Xverify:none ${JAVA_OPTS} -cp ${CP} ${MAIN_CLASS}
}
 
function stop()
{
    # 支持集群部署
    kill `pgrep -f ${APP_BASE_PATH}` 2>/dev/null
    
    # kill 命令不使用 -9 参数时，会回调 onStop() 方法，确定不需要此回调建议使用 -9 参数
    # kill `pgrep -f ${MAIN_CLASS}` 2>/dev/null
 
    # 以下代码与上述代码等价
    # kill $(pgrep -f ${MAIN_CLASS}) 2>/dev/null
}
 
if [[ "$COMMAND" == "start" ]]; then
	start
elif [[ "$COMMAND" == "stop" ]]; then
    stop
else
    stop
    start
fi
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

注意要首先根据项目入口类，修改一下上面内容中的 MAIN_CLASS 变量值，Windows 下的 jfinal.bat 脚本也同样如此

启动项目命令：./jfinal.sh start

关闭项目命令：./jfinal.sh stop

重启项目命令：./jfinal.sh restart

特别注意：使用以上命令行时，先要使用 mvn clean package 将项目打包，然后使用 cd 命令跳转到打好的包的目录下面执行命令。而不是 cd 跳转到项目根目录下面去执行命令，很多人犯这种错误。打包方法见紧接着的下一小节《6、打包》

限于篇幅在此不再贴出 windows 脚本内容，可下载官网首页右侧的 jfinal demo 获取。最新版本的脚本在此可以下载到：https://gitee.com/jfinal/jfinal-undertow

windows 脚本的使用方法如下：

启动项目命令：jfinal.bat start

关闭项目命令：jfinal.bat stop

重启项目命令：jfinal.bat restart

注意：linux、mac 下的脚本文件换行字符必须是 '\n'，而 windows 下必须是 "\r\n"，否则脚本无法执行，并会输出无法理解的错误信息，难以排错。如何查看脚本文件中的换行字符见文档：https://www.jfinal.com/doc/1-5

强烈建议：强烈建议下载首页的 jfinal_demo_for_maven.zip，从中可以获取到以上 5 小节所涉及的 pom.xml、package.xml、jfinal.sh 等配置文件与脚本文件。确保下载到最新版本。

# 6、打包

打开命令行终端，cd 命令进入项目根目录，运行以下命令即可打包

mvn clean package
1

执行上述打包命令以后，在项目根下面的 target 目录下面会出现打好的 xxx.zip，解压该 zip 文件使用命令行 ./jfinal.sh start 即可运行

除了 zip 文件还会在 target 下面生成一个目录，在该目录下面使用命令行 ./jfinal.sh start 可启动项目，该目录下面的内容与 zip 文件中的内容是完全一样的。

# 7、部署

将上述打包命令生成的 zip 文件上传到服务器并解压即完成了部署工作，基于 jfinal-undertow 开发项目的最大优势就是不需要下载、安装、配置 tomcat 这类 server

# 8、fatjar 打包部署

fatjar 打包是指将项目中所有 class、所有资源以及所有 jar 包依赖全部打包到一个单独的 jar 包之中，打包好的独立 jar 包可以很方便复制、部署、运行，非常适合于做微服务项目开发，也很适合没有 web 资源或者 web 资源很少的项目

具体的用法可以在官网首页下载 jfinal-demo-for-maven，其中的 doc 目录下面有文档详细介绍了此方法，后续会在文档频道添加 fatjar 打包方法

# 9、jfinal-undertow 的主要优势

1：极速启动，启动速度比 tomcat 快 5 到 8 倍。jfinal.com 官网启动时间在 1.5 秒内

2：Undertow 是红帽公司的开源产品，是 Wildfly 默认的 Web 服务器，Java Web 服务器市场占有率高于 Jetty，仅次于 Tomcat

3：极简精妙的热部署设计，实现极速轻量级热部署，让开发体验再次提升一个档次

4：性能高于 tomcat、jetty，可替代 tomcat、jetty 用于生产环境

5：undertow 为嵌入式而生，可直接用于生产环境部署，部署时无需下载服务，无需配置服务，十分适合微服务开发、部署

6：告别 web.xml、告别 tomcat、告别 jetty，节省大量打包与部署时间。令开发、打包、部署成为一件开心的事

7：功能丰富，支持 classHotSwap、WebSocket、gzip 压缩、servlet、filter、sessionHotSwap 等功能

8：支持 fatjar 与 非 fatjar 打包模式，便于支持微服务

9：开发、打包、部署一体化，整个过程无需对项目中的任何地方进行调整或修改，真正实现从极速开发到极速部署

Last Updated: 9/8/2023, 9:00:03 AM

← 1.4 jfinal-undertow 高级用法 →